TimePunch User Profile Service
UserProfileDataDto
Diese Klasse enthält alle Profile Informationen die auch über die Einzelmethoden abrufbar sind. Um das Objekt zu erhalten, werden jedoch spezielle Exportrechte benötigt.
| Datatype | Name | Description |
|---|---|---|
| UserProfileDto | Profile | The basic profile information (e.g. Name, email etc) |
| UserProfileDetailsDto | Details | The detailed profile information (e.g. working time contract) |
| UserProfileDefaultsDto | Defaults | The default information that is used as an offset or pre-set for internal calculations. |
| UserProfileRightsDto | Rights | The permission information for the TimePunch Profile. |
| UserProfileSensitiveDto | Sensitive | The sensitive user information for the TimePunch Profile. Those information can only be retrieved if the user has permissions to access those informations. (userSensitive@export) |
| Bool | IsPasswordSet | True, if the user has a password set. |
| String | PasswordWriteOnly | [Write Only] Password that shall be used for the given user profile. |
UserProfileDefaultsDto : UserProfileDto
Diese Klasse ist abgeleitet vom UserProfileDto und enthält die Vorgabewerte die zur Berechnung in TimePunch verwendet werden.
| Datatype | Name | Description |
|---|---|---|
| Double | PreviousOvertime | Offset value for the overtime calculation. |
| Double | PreviousSickdays | Offset value for the sickdays. |
| LeaveSetting | LeaveSetting | Defines how the leave offset shall be used for calculation. TakeAsOffset => In the first year, the user has extra holiday available, because he/she carry it forward from the previous time recording. TakeAsStatic => In the first year, the user does not own the complete holidays, but the one he entered |
| Double? | AdditionalLeave | Leave hours that will be added to the annual leave in the first year. This feature is only used when LeaveSetting is set to TakeAsOffset. |
| Double | AdditionalLeaveAsDays | Leave that will be added to the annual leave in the first year. This feature is only used when LeaveSetting is set to TakeAsOffset. |
| Double? | RemainingLeave | The leave hours that will be used instead of the yearly holidays in the first year. This feature is only used when LeaveSetting is set to TakeAsStatic. |
| Double | RemainingLeaveAsDays | The leave that will be used instead of the yearly holidays in the first year. This feature is only used when LeaveSetting is set to TakeAsStatic. |
| Double | LeavePerDay | Defines the length of a leave day if leave calculation is set to hours. |
| LeaveCalculation | LeaveCalculation | Defines if the leave defaults are calculated in days or hours |
| Bool | IsLocked | [Readonly] True, if the defaults can’t be changed because months are locked. |
UserProfileDetailsDto : UserProfileDto
Die Klasse ist abgeleitet von UserProfileDto und enthält alle Detaildaten des Mitarbeiterprofils.
| Datatype | Name | Description |
|---|---|---|
| String | PersonnelNumber | Personnel number of the staff member. |
| String | UserCode | Barcode of the staff member. Used to identify the user by a barcode scanner. |
| Double | ChargingJourneyTime | The percentage of working time that shall be booked when the user enters a driving time period. |
| String | Timezone | The time zone for the user. The time zone is used to calculate the correct logon/logoff time. |
| CountryDto | Country | Country that is used for holiday calculation |
| RegionDto | Region | Region that is used for holiday calculation |
| WorkContract | WorkContract | Work Contract enumeration that specifies how the staff member shall be booked. Employee = 0 Freelancer = 1 Wageworker = 2 Shiftworker = 3 |
| Double? | PaidTime | The regular paid time, if the user is employed as a wage worker or shift worker. |
| OvertimeCutMode | OvertimeCutMode | Defines if the overtime shall be cut. Possible values are None, Monthly or Cumulative |
| Double | OvertimeStartsAt | Number of overtime that is included in the working contract. Above this limit the working time will be counted as overtime. |
| Bool | ExceptionForMinus WorkingTimeAccount | Defines, if there is an exception for overtime starts at, if the user has a negative working time account |
| Double | MaximumOvertime | Maximum limit of overtime until which the working time will be counted as overtime. |
| Bool | IsOvertimeAboveLimitPaid | True, if the working time above the maximum overtime shall be marked as paid out. |
| LeaveCarryForward | LeaveCarryForward | Value that defines when the new leave shall be added to the staff member. Allowed values are BeginOfJanuary through BeginOfDecember. |
| LeaveExpiration | LeaveExpiration | Defines when the leave of the previous year will expire. Allowed values are Instantly, Never and EndOfJanuary through EndOfDecember. |
| Double | AnnualLeaveAsDays | Amount of leave days with that the user can plan with. |
| Double | AnnualLeave | Amount of leave hours with that the user can plan with. |
| Double | LeavePerDay | Defines the length of a leave day if leave calculation is set to hours |
| LeaveCalculation | LeaveCalculation | Defines if the leave defaults are calculated in days or hours |
| WagePayment | WagePayment | Defines how the wage gets payed (BasedOnWorkingTimeModel, BasedOnFixedQuotaOfHours, BasedOnMaxQuotaOfHours, BasedOnFixedQuotaOfHoursUntilLimit) |
| Double | LowerOvertimeLimit | If the wage payment is set to “BasedOnFixedQuotaOfHoursUntilLimit”, this field defines to which lower border the user gets paid. |
UserProfileImageDto : UserProfileDto
Diese Klasse wird dazu genutzt um Profilbilder der Mitarbeiter zu laden oder zu aktualisieren. Die Klasse ist eine Ableitung von UserProfileDto.
| Datatype | Name | Description |
|---|---|---|
| ImageFormat | ImageFormat | The used image format. For uploading only Original can be used. |
| Byte[] | ImageData | The image data as PNG or JPG Format. |
UserProfileRightsDto: UserProfileDto
Diese Klasse enthält die Basisdaten des Mitarbeiter Profils und zusätzlich die Berechtigungsinformationen. Die Klasse ist eine Ableitung von UserProfileDto.
| Datatype | Name | Description |
|---|---|---|
| UserRights | UserRights | Permission group of the user (None, View, Edit, Full, HumanResource, Admin) |
UserProfileSensitiveDto : UserProfileDto
Diese Klasse enthält die datenschutzrelevanten Informationen des Mitarbeiters.
| Datatype | Name | Description |
|---|---|---|
| string | Birthname | Birth name of the user |
| String | PrivatePostalAddress | Private postal address of the user |
| DateTime? | Birthday | Date when the user was born |
| String | Birthplace | Place where the user was born |
| String | Nationality | Nationality of the user |
| DateTime? | DateOfJoining | Date when the user joined the company |
| DateTime? | DateOfLeaving | Date when the user left the company, or NULL if the user is still employed. |
| String | InsurancePolicyNumber | The insurance policy number |
| Bool | IsMainJob | True, if the current job is the main job of the user |
| Bool | HasOtherJobs | True, if the user also have other jobs |
| String | JobDescription | Description of the work that the user does |
| Bool | IsRelatedToEmployer | Defines if the user is in any relation to his employer (e.g. sister, son etc) |
| Bool | IsFreedFromPensionInsurance | Defines if the user is freed from pension insurance. |
| String | BankingInstitut | Name of the banking institut for monthly salary submission. |
| String | InternationalBank AccountNumber | IBAN Code of the employee |
| String | BankIdentifierCode | BIC Code of the banking institute |
| Double | HourlyWage | Hourly wage of the user if he/she is employed as a wage worker or shift worker |
| Double | Salary | Monthly salary of the user if he/she is employed as an employee |
| String | FurtherUserInformation | Additional user information |